Crate risc0_zkvm

The RISC Zero zkVM is a RISC-V virtual machine that produces zero-knowledge proofs of code it executes. By using the zkVM, a cryptographic receipt is produced which anyone can verify was produced by the zkVM’s guest code. No additional information about the code execution (such as, for example, the inputs provided) is revealed by publishing the receipt.

In addition to our reference documentation on docs.rs, we have additional (non-reference) resources for using our zkVM that you may also find helpful, especially if you’re new to the RISC Zero zkVM. These include:

• Our Hello World demo – a minimal zkVM application that works out-of-the-box.
• Our zkVM Tutorial, which walks you through writing your first zkVM project.
• The cargo risczero tool. It includes a new command which generates code for building and launching a zkVM guest and guidance on where projects most commonly modify host and guest code.
• The examples folder, which contains various examples using our zkVM.
• This clip from our presentation at ZK Hack III gives an overview of the RISC Zero zkVM. Our YouTube channel has many more videos as well.
• We track zkVM issues with known workarounds using the rust guest workarounds GitHub tag. If you’re having problems running your code in the zkVM, you can see if there’s a workaround, and if you’re using a workaround, you can track when it gets resolved to a permanent solution.
• And more on the RISC Zero developer website!

Crate Feature Flags

The following crate feature flags are available.

Note that in order to use risc0-zkvm in the guest, you must disable the “prove” feature by setting default-features = false.

Feature	Target(s)	Implies	Description
cuda		prove, std	Turns on CUDA GPU acceleration for the prover. Requires CUDA toolkit to be installed.
metal	macos	prove, std	Turns on Metal GPU acceleration for the prover.
profiler	all		Tracks where cycles are spent during guest execution as an aid to code optimization.
prove	all except rv32im	std	Enables the prover, incompatible within the zkvm guest.
std	all		Support for the Rust stdlib.

Modules

• guest
  The RISC Zero zkVM’s guest-side RISC-V API.
• recursion
  Re-exports for recursion
• serde
  Serialization and deserialization tools for the RISC Zero zkVM
• sha
  SHA-256 hashing services

Macros

• declare_syscall
  Construct a SyscallName declaration at compile time.
• entry
  Used for defining a main entrypoint.

Structs

• ApiClient
  A client implementation for interacting with a zkVM server.
• ApiServer
  A server implementation for handling requests by clients of the zkVM.
• BonsaiProver
  An implementation of a Prover that runs proof workloads via Bonsai.
• Bytes
  A cheaply cloneable and sliceable chunk of contiguous memory.
• Executor
  The Executor provides an implementation for the execution phase.
• ExecutorEnv
  The crate::Executor is configured from this object.
• ExecutorEnvBuilder
  A builder pattern used to construct an ExecutorEnv.
• ExternalProver
  An implementation of a Prover that runs proof workloads via an external r0vm process.
• FileSegmentRef
  A basic implementation of a SegmentRef that saves the segment to a file
• HalPair
  A pair of Hal and CircuitHal.
• Loader
  Loads data into the zkVM image
• LocalProver
  A Prover implementation that selects a crate::ProverServer by calling get_prover_server.
• MemoryImage
  An image of a zkVM guest’s memory
• Program
  A RISC Zero program
• ProverOpts
  Options to configure a Prover.
• Receipt
  A receipt attesting to the execution of a Session.
• ReceiptMetadata
  Data associated with a receipt which is used for both input and output of global state.
• Segment
  The execution trace of a portion of a program.
• SegmentReceipt
  A receipt attesting to the execution of a Segment.
• SegmentReceipts
  A wrapper around Vec<SegmentReceipt>.
• Session
  The execution trace of a program.
• SimpleSegmentRef
  A very basic implementation of a SegmentRef.
• SystemState
  Represents the public state of a segment, needed for continuations and receipt verification.
• VerifierContext
  Context available to the verification process.

Enums

• ExitCode
  Indicates how a Segment or Session’s execution has terminated
• InnerReceipt
  An inner receipt can take the form of a SegmentReceipts collection or a SuccinctReceipt.
• TraceEvent
  An event traced from the running VM.

Constants

• ALLOWED_IDS_ROOT
  Merkle root of the RECURSION_CONTROL_IDS
• MEM_SIZE
• PAGE_SIZE
  Size of a zkVM memory page.
• POSEIDON_CONTROL_ID
  Control ID for Poseidon

Traits

• Connector
  Connects a zkVM client and server
• Prover
  A Prover can execute a given MemoryImage or ELF file and produce a Receipt that can be used to verify correct computation.
• ProverServer
  A ProverServer can execute a given MemoryImage and produce a Receipt that can be used to verify correct computation.
• SegmentRef
  A reference to a Segment.
• SessionEvents
  The Events of Session

Functions

• align_up
  Align the given address addr upwards to alignment align.
• default_prover
  Return a default Prover based on environment variables, falling back to a default CPU-based prover.
• get_prover_server
  Select a ProverServer based on the specified ProverOpts and currently compiled features.
• is_dev_mode
  Returns true if dev mode is enabled.

Type Aliases

• Result
  Result<T, Error>